// 快递公司模型定义文件
// 该文件定义了快递公司数据表的结构和相关配置

const Sequelize = require('sequelize');

/**
 * 定义快递公司模型
 * @param {Sequelize} sequelize - Sequelize实例
 * @param {DataTypes} DataTypes - Sequelize数据类型
 * @returns {Model} 快递公司模型
 */
module.exports = function(sequelize, DataTypes) {
  return sequelize.define('courier_companies', {
    // 快递公司ID字段 - 主键，自增
    courier_id: {
      autoIncrement: true,              // 设置为自增字段
      autoIncrementIdentity: true,      // PostgreSQL的自增标识
      type: DataTypes.INTEGER,          // 数据类型为整数
      allowNull: false,                 // 不允许为空
      primaryKey: true                  // 设置为主键
    },
    
    // 快递公司名称字段
    courier_name: {
      type: DataTypes.STRING(100),      // 数据类型为字符串，最大长度100
      allowNull: false                  // 不允许为空
    },
    
    // 快递公司编码字段
    courier_code: {
      type: DataTypes.STRING(20),       // 数据类型为字符串，最大长度20
      allowNull: false                  // 不允许为空
    }
  }, {
    sequelize,                          // Sequelize实例
    tableName: 'courier_companies',     // 指定数据表名
    schema: 'public',                   // 指定数据库模式
    hasTrigger: true,                   // 表具有触发器
    timestamps: true,                   // 启用时间戳
    createdAt: 'created_at',            // 指定创建时间字段名
    updatedAt: 'updated_at',            // 指定更新时间字段名
    indexes: [                          // 索引定义
      {
        name: "courier_companies_pkey",         // 索引名称
        unique: true,                           // 唯一索引
        fields: [                               // 索引字段
          { name: "courier_id" },               // 索引字段为快递公司ID
        ]
      },
      {
        name: "courier_companies_courier_code_unique", // 索引名称
        unique: true,                           // 唯一索引
        fields: [                               // 索引字段
          { name: "courier_code" },             // 索引字段为快递公司编码
        ]
      }
    ]
  });
};